home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / remote / swe_20.zip / SWE.DOC < prev    next >
Text File  |  1993-03-14  |  8KB  |  169 lines
  1. ------------------------------------------------------------------------------
  2.                         SWE, Switch Fullscreen Editor
  3. ------------------------------------------------------------------------------
  4.  
  5.             Version : 2.0 - Mar. 14, 1993
  6.  
  7.             By: Jos Bergman, (c) JayBeeSoft 1993
  8.             Zwolle, The Netherlands
  9.  
  10.    FidoNet: 2:512/54   MultiServer - Node 1  +31-38-541358 (V32b, HST16k8)
  11.             2:512/315  MultiServer - Node 2  +31-38-540882 (V32b, ZYX16k8)
  12.  
  13.  
  14. ------------------------------------------------------------------------------
  15. New in version 2.0 : Made SWE RA2.00Γ1 compatible. No further changes.
  16.              Please use the EzyEdit options with care.. This editor
  17.              seems to be a little troublesome with SWE. I'll try to
  18.              make this one work perfectly also.. ;)
  19. New in version 1.1 : Enabled usage of extra commandline parameters for the
  20.                      editor in SWE.CTL. The new EzyEdit editor requires some
  21.                      additional info on startup. Extra commandline parameters
  22.                      can be defined in the CTL-file as of now.
  23. ------------------------------------------------------------------------------
  24.  
  25.  
  26. This one's freeware, which means you're allowed to distribute and use this
  27. program freely, no costs are involved. Also no person or organization may
  28. distribute this program when payment is asked other than for the physical
  29. media carrying this program.
  30.  
  31. Disassembling, reverse engineering and other changes to the program are
  32. a violation of the above copyright, and thus not allowed.
  33.  
  34. This DOC-file is just a quick & dirty description of the program and it's
  35. installation info. It's a simple to install/use program and does not need
  36. a lot of documentation. Besides that, I'd like to keep the archive as small
  37. as can be.. :-)
  38.  
  39. ------------------------------------------------------------------------------
  40.  
  41. SWE (SWitchEditor), What does it do ?
  42. -------------------------------------
  43.  
  44. Well, quite simple.. By installing this program you offer your users the
  45. possibility to choose their own favourite fullscreen-editor to be used when
  46. entering messages in your bulletin board system.
  47.  
  48. SWE, Who is it for ?
  49. --------------------
  50.  
  51. For SysOps of a RemoteAccess, SuperBBS or QuickBBS bulletin board system.
  52. The program had been tested on all three of this systems, so I guess it
  53. should work for these SysOps.
  54.  
  55. SWE, How does it work ?
  56. -----------------------
  57.  
  58. The program should be used as a replacement of your current 'fixed' fullscreen-
  59. editor in your BBS-setup. This means a commandline for SWE replaces in fact
  60. the commandline that is defined in your setup for the fullscreen-editor.
  61. SWE knows of one commandline parameter only.. When used in a multinode
  62. environment, you should pass the nodenumber here. For RAccess this would f.i.
  63. be the '*N' option.
  64.  
  65. <Path>\SWE.EXE [-N:*N] [*M]
  66.  
  67. This parameter will be added to the parameters your BBS-package passes to the
  68. fullscreen-editor (in this case to SWE.. ;).
  69.  
  70. SWE needs some external data to work properly. First of all you need to define
  71. some usersecurity flags. For every editor you want to install you need one (1)
  72. flag. SWE in fact has no real limit to this, so if you wanted to, you could
  73. install exactly as many editors as you have flags available in your userfile.
  74.  
  75. Furthermore you need something to offer your users a possibility to switch the
  76. current editor. This means you have to create some menu-options (f.i. in your
  77. 'User Settings' menu) to toggle the right flags. This is done by either using
  78. the 'toggle user flag' menu-option, or 'SetFlag' in a questionaire file.
  79.  
  80. An example-menu has been added to this archive, one using some ANS/ASC files
  81. to show the current editor to the user, the other one using the internal
  82. menu-texts.. When you choose one of the editors, the flag that is defined for
  83. this editor is toggled on, the other ones are set off..
  84.  
  85. Finally you need a controlfile in which the editors to be used are being
  86. defined. This file (SWE.CTL) should be located in the directory where SWE.EXE
  87. is. This could be any directory as far as I'm concerned..
  88. Every line in this control file (SWE.CTL) holds one editor-definition.
  89. The syntax for an editor-definition is :
  90.  
  91. <Userflag> <Drive:Path\Editorname> <Parameters>[*N] [*M]
  92.  
  93. The first two entries are quite self-explaining I guess, the editor may again
  94. be in any directory. For a detailled installation of the editor you can act
  95. exactly like when you would install the editor as a 'standalone' one.
  96.  
  97. The <Parameters> parameter ( ;-) ) has become necessary since the birth of
  98. the EzyEdit editor. This one requires some additional info on its command line.
  99. This Info can be added here. See the example below and the sample CTL-file.
  100.  
  101. The last two parameters perhaps need some extra explanation. Both are optional,
  102. so you only have to supply them when needed by the editor or wanted by you.
  103. Usage of the '*N' parameter will supply the BBS-nodenumber SWE is currently
  104. running on to the editor. TopEd is an example of an editor that needs this
  105. one when used in a multinode environment.
  106. EzyEdit needs the *N parameter without a space between the <Parameters> and
  107. the nodenumber !
  108.  
  109. Usage of the '*M' parameter is up to you... When you use some editors that
  110. are quite memoey-consuming you could consider adding this parameter to the
  111. editor-definition line. This one causes SWE to swap itself out of memory
  112. when the editor is started, leaving just a small part of SWE in memory.
  113. SWE first tries to swap to EMS, when you haven't got any EMS (left), SWE
  114. uses a swap to your harddisk.
  115.  
  116. An example for the SWE.CTL file using the three most used (are there any
  117. other ? ;) editors :
  118.  
  119. D5 C:\EDITORS\TOPED.EXE *N *M
  120. D6 C:\EDITORS\GEDIT.EXE *M
  121. D7 C:\EDITORS\QUICKED.EXE
  122. D8 C:\EDITORS\EZYEDIT.EXE -RA -N*N *M
  123.  
  124. SWE, Some final last words...
  125. -----------------------------
  126.  
  127. One thing to remember : SWE has no influence on the usersetting of the
  128. fullscreen-editor. This means the user should have toggled the fullscreen-
  129. editor toggled on to be able to use the chosen editor. When this isn't the
  130. case it wouldn't matter which editor the user would choose, he still would
  131. get the internal line-editor when writing messages..
  132.  
  133. I know this isn't the first editor-switcher that was written, this one was
  134. created because the one that arrived here first wasn't doing what I wanted
  135. it to do, so I started writing one of my own.
  136. The result of this is that you now can't just choose your own fullscreen-
  137. editor, but also you favourite switcher... :-)
  138.  
  139. Have fun with it !
  140.  
  141. SWE, Credits where credits are due...
  142. -------------------------------------
  143.  
  144.     Borland, for my Turbo Pascal package.
  145.     LiveSystems Software, for the RADoor Door Writing TPU's.
  146.         (And Gerhard Hoogterp himself, for some valuable hints..)
  147.     Andrew Milner & Continental Software, for RemoteAccess.
  148.     Aki Antman & Risto Virkkala, for SuperBBS.
  149.     Pegasus Software, for QuickBBS.
  150.     John & Steve Richardson & TopSoft Software, for TopEd.
  151.     Chris Patterson, for GEdit.
  152.     Dror Tirosh, for QuickEd.
  153.     Brad Vonarx, for EzyEdit.
  154.  
  155. SWE, The Beta-Team !
  156. --------------------
  157.  
  158.     Last but not least my beta-bashers
  159.         (Thanks for your efforts and valuable tips !):
  160.  
  161.       Eddy Emck          Computershop Utrecht BBS, 2:282/701
  162.       Frank Hemmelder    NNN SuperBBS            , 2:500/239
  163.       Sander Eek         QuickBBS Support Europe , 2:283/507
  164.       Ron Huiskes        Interface BBS           , 2:281/506
  165.  
  166.  
  167.  
  168. --- EOD ---
  169.